Skip to content

feat(zod-openapi): add defineOpenAPIRoute and openapiRoutes for batch route registration#1752

Merged
yusukebe merged 11 commits intohonojs:mainfrom
destroSunRay:zod-openapi-with-better-compatability-for-rpc-2
Apr 12, 2026
Merged

feat(zod-openapi): add defineOpenAPIRoute and openapiRoutes for batch route registration#1752
yusukebe merged 11 commits intohonojs:mainfrom
destroSunRay:zod-openapi-with-better-compatability-for-rpc-2

Conversation

@destroSunRay
Copy link
Copy Markdown
Contributor

@destroSunRay destroSunRay commented Feb 16, 2026

Note
This is my first time contributing to open-source, if I made mistakes I'm sorry. Any feedback is welcome.

Description

This PR adds two new utilities to improve route definition and registration in @hono/zod-openapi:

  • defineOpenAPIRoute: Provides explicit type safety for route definitions
  • openapiRoutes: Enables batch registration of multiple routes with full type safety

Problem

  • Registering many routes individually was repetitive and verbose
  • Type inference for complex route configurations was challenging
  • Organizing routes across multiple files was difficult
  • No built-in support for conditional route registration
  • RPC type safety was hard to maintain across scattered route registrations

Solution

  • defineOpenAPIRoute: Wraps route definitions with explicit types for better IDE support and type checking
  • openapiRoutes: Accepts an array of route definitions and registers them all at once
  • Supports addRoute flag for conditional registration
  • Maintains full type safety and RPC support through recursive type merging
  • Enables clean modular organization of routes

Benefits

  • ✅ Reduced boilerplate code
  • ✅ Better type inference and IDE autocomplete
  • ✅ Easier code organization and maintainability
  • ✅ Declarative conditional routes
  • ✅ Full backward compatibility

Examples

See the updated README for usage examples.

Testing

  • All existing tests pass (102/102)
  • Added tests for new functionality
  • Verified type inference works correctly

Documentation

  • Updated package README with usage examples

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Feb 16, 2026 •
edited
Loading

🦋 Changeset detected

Latest commit: 82928f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@hono/zod-openapi Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@destroSunRay
Copy link
Copy Markdown
Contributor Author

destroSunRay commented Feb 16, 2026

This pull request is the implementation for the proposed feature 1751.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 2, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.73%. Comparing base (031f805) to head (82928f8).
⚠️ Report is 59 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1752      +/-   ##
==========================================
+ Coverage   92.68%   92.73%   +0.04%     
==========================================
  Files         112      112              
  Lines        3733     3744      +11     
  Branches      946      946              
==========================================
+ Hits         3460     3472      +12     
+ Misses        245      244       -1     
  Partials       28       28
Flag Coverage Δ
zod-openapi 94.90% <100.00%> (+1.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@destroSunRay
Copy link
Copy Markdown
Contributor Author

destroSunRay commented Mar 17, 2026

I pushed fixes for the previous CI errors. Could a maintainer please rerun the failing workflow checks (or “Re-run all jobs”) when you have a moment? Thanks!

Copilot AI review requested due to automatic review settings April 12, 2026 06:27
Copilot AI reviewed Apr 12, 2026
View reviewed changes
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds new batch route-definition/registration utilities to @hono/zod-openapi to make large sets of createRoute() + openapi() registrations less repetitive while preserving RPC typing.

Changes:

  • Introduces defineOpenAPIRoute/OpenAPIRoute and supporting types for explicitly-typed route definitions.
  • Adds OpenAPIHono#openapiRoutes() for registering many OpenAPI routes in one call (with optional addRoute gating).
  • Updates README, tests, eslint suppressions, and adds a changeset for the new feature.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
packages/zod-openapi/src/index.ts Adds defineOpenAPIRoute types/util and openapiRoutes() batch registration method.
packages/zod-openapi/src/index.test.ts Adds extensive tests for the new utilities and adjusts a few existing tests/types.
packages/zod-openapi/README.md Documents batch registration and conditional/modular route organization.
packages/zod-openapi/eslint-suppressions.json Updates suppression counts following test changes.
.changeset/quiet-snakes-stare.md Declares a minor release and summarizes the new APIs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

yusukebe
yusukebe approved these changes Apr 12, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@yusukebe yusukebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@yusukebe
Copy link
Copy Markdown
Member

yusukebe commented Apr 12, 2026

Hey @destroSunRay

This is a good feature! I've added some changes by myself, and it looks good. Let's go with this. Thank you for your contribution!

@yusukebe yusukebe merged commit fe0f8e4 into honojs:main Apr 12, 2026
96 checks passed
This was referenced Apr 12, 2026
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@yusukebe yusukebe yusukebe approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@destroSunRay @yusukebe